Fixing the documentation #227
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixing documentation so that buildthedocs can build documentation properly.
Developer(s): Alice DuVivier
Please suggest code Pull Request reviewers in the column at right.
Are the code changes bit for bit, different at roundoff level, or more substantial? b4b
Please include the link to test results or paste the summary block from the bottom of the testing output below.
Does this PR create or have dependencies on Icepack or any other models? N
Is the documentation being updated with this PR? (Y/N) Y
If not, does the documentation need to be updated separately at a later time? (Y/N) N
Note: "Documentation" includes information on the wiki and .rst files in doc/source/,
which are used to create the online technical docs at https://readthedocs.org/projects/cice-consortium-cice/.
It looks like there were two problems.
(1) The original missing comma after part of one of the entries. I fixed that in an earlier PR.
(2) The "example templates" I had put into the master_list.bib seemed to crash the builds. This issue The second seems to be only with the online readthedocs build and does not manifest itself with a sphinx build on my laptop. I have no idea why there is the discrepancy with the two build methods, but I have tested this PR with my laptop sphinx AND my readthedocs account. See link below for "pass" builds:
https://readthedocs.org/projects/cice/builds/
To fix this I've put the example template in a separate text file so that the formatting and notes are preserved but not causing failing builds.